Skip to content

feat(dashboard): remove tooltip from root key permission toggle#2618

Merged
chronark merged 3 commits intounkeyed:mainfrom
unrenamed:feat/remove-api-scope-permissions-tooltip
Oct 30, 2024
Merged

feat(dashboard): remove tooltip from root key permission toggle#2618
chronark merged 3 commits intounkeyed:mainfrom
unrenamed:feat/remove-api-scope-permissions-tooltip

Conversation

@unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 30, 2024

What does this PR do?

Fixes #2234

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Create at least one API in your workspace;
  • Navigate to /settings/root-keys/new;
  • Scroll down to the APIs section and expand it if collapsed;
  • Observe there is no tooltip after you hover over any of the API-scoped permissions;

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Simplified UI for the PermissionToggle component by removing the Tooltip and permissionName prop.
    • Streamlined display of permissions in the PermissionManagerCard by eliminating the Tooltip and permission name.
  • Bug Fixes

    • Ensured state management for collapsible sections remains functional despite UI changes.

@changeset-bot
Copy link

changeset-bot bot commented Oct 30, 2024

⚠️ No Changeset found

Latest commit: 28925fe

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 30, 2024

@unrenamed is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve modifications to the Client component in client.tsx and the PermissionManagerCard component in permission-manager-card.tsx. The permissionName prop has been removed from the PermissionToggle component, and the associated Tooltip component has been eliminated, resulting in a simplified user interface. The Checkbox and Label components are now rendered directly without Tooltip wrapping. Additionally, similar modifications have been made to the PermissionManagerCard, where the Tooltip has been removed and the structure adjusted to streamline the display of permissions. The overall logic for permission handling and API key management remains unchanged.

Changes

File Path Change Summary
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx Removed permissionName prop from PermissionToggle and eliminated Tooltip component. Adjusted structure of PermissionToggle to render Checkbox and Label directly.
apps/dashboard/app/(app)/settings/root-keys/[keyId]/permissions/permission-manager-card.tsx Removed Tooltip from permission actions and adjusted rendering to exclude permission name, enhancing layout but reducing information presented.

Assessment against linked issues

Objective Addressed Explanation
Tooltip should be positioned to avoid overflow (#2234) The Tooltip component has been removed entirely.

Possibly related PRs

Suggested labels

Feature, :joystick: 150 points, hacktoberfest

Suggested reviewers

  • chronark
  • mcstepp
  • perkinsjr

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vercel
Copy link

vercel bot commented Oct 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 11:42pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 11:42pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 11:42pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 11:42pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 11:42pm

@github-actions github-actions bot added 🕹️ 150 points Bug Something isn't working labels Oct 30, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 30, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@vercel vercel bot temporarily deployed to Preview – engineering October 30, 2024 14:09 Inactive
@vercel vercel bot temporarily deployed to Preview – engineering October 30, 2024 14:11 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (1)

335-342: Fix indentation for consistent code formatting.

The indentation of these lines appears to be inconsistent with the rest of the file. Consider adjusting the indentation to match the surrounding code style.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7c76890 and 62827f9.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (1 hunks)
🔇 Additional comments (1)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (1)

335-342: LGTM! Changes successfully address the tooltip overflow issue.

The implementation successfully:

  1. Removes the tooltip functionality that was causing overflow issues
  2. Maintains the core permission toggle functionality
  3. Preserves responsive layout and styling
  4. Keeps the UI clean and functional

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (1)

335-342: Consider enhancing screen reader support.

The removal of tooltips in favor of always-visible descriptions is a good improvement. Consider adding aria-description to enhance screen reader support:

 <div className="w-1/3 flex items-center gap-2">
   <Checkbox
     checked={checked}
     onCheckedChange={() => {
       setChecked(!checked);
     }}
+    aria-description={description}
   />
   <Label className="text-xs text-content">{label}</Label>
 </div>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7c76890 and 62827f9.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (1 hunks)
🔇 Additional comments (2)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (2)

335-342: LGTM! Improved accessibility and responsive layout.

The simplified structure maintains good accessibility with proper label association and clear visual hierarchy. The responsive layout ensures readability across different screen sizes.


335-342: Confirms resolution of tooltip overflow issue.

The changes successfully address the tooltip overflow issue (#2234) by:

  1. Removing the problematic tooltip
  2. Implementing an always-visible description with proper responsive layout
  3. Maintaining clear information hierarchy without compromising UX

This is a solid improvement to the permission toggle UI.

@vercel vercel bot temporarily deployed to Preview – dashboard October 30, 2024 16:30 Inactive
@chronark
Copy link
Collaborator

Could you remove them here too?
/settings/root-keys/[keyId]

https://share.cleanshot.com/h267bj34

@chronark
Copy link
Collaborator

I might not be around tomorrow to review, so I'll award the points now, trusting you to fix it

/award 150

@oss-gg
Copy link

oss-gg bot commented Oct 30, 2024

Awarding unrenamed: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/unrenamed

@unrenamed unrenamed requested a review from chronark October 30, 2024 16:49
@vercel vercel bot temporarily deployed to Preview – engineering October 30, 2024 16:49 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/settings/root-keys/[keyId]/permissions/permission-manager-card.tsx (1)

107-109: Consider adding a comment about the width ratio decision.

The 1/3 and 2/3 width split provides a good balance for the content, but it would be helpful to add a brief comment explaining this design decision for future maintainers.

-        <div className="w-1/3 flex items-center gap-2">
+        {/* Action takes 1/3 width, description takes 2/3 for optimal readability */}
+        <div className="w-1/3 flex items-center gap-2">
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 62827f9 and 28925fe.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/[keyId]/permissions/permission-manager-card.tsx (1 hunks)
🔇 Additional comments (2)
apps/dashboard/app/(app)/settings/root-keys/[keyId]/permissions/permission-manager-card.tsx (2)

104-109: LGTM! Clean implementation of the permission display.

The new layout with the Check icon and direct Label rendering provides a cleaner, more consistent interface. This aligns well with the PR objective of removing tooltips and matches the requested changes.


Line range hint 15-16: Future improvements noted in TODOs.

The component has planned enhancements for accordion functionality and empty state visualization. While outside the scope of this PR, these would further improve the user experience.

Let's check if there are any existing issues tracking these improvements:

Would you like me to create GitHub issues to track these planned improvements?

Also applies to: 29-29

✅ Verification successful

Consider tracking planned UX improvements

The code contains two TODO comments for future enhancements:

  • Adding accordion functionality with an expandable prop
  • Adding visualization for empty permission states

Since there are no existing issues or documentation discussing these features, consider creating dedicated issues to track these improvements for better user experience.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for related issues about accordion or empty state
gh issue list --search "in:title accordion permission" --limit 5
gh issue list --search "in:title empty permission state" --limit 5

Length of output: 135


Script:

#!/bin/bash
# Let's first check the actual TODO comments in the file
rg -A 2 "TODO" "apps/dashboard/app/(app)/settings/root-keys/[keyId]/permissions/permission-manager-card.tsx"

# Also search for any related existing issues or discussions in the codebase
rg -i "accordion.*permission|permission.*accordion|empty.*state.*permission" -g "*.{md,mdx}"

Length of output: 539

@chronark chronark enabled auto-merge October 30, 2024 23:37
@vercel vercel bot temporarily deployed to Preview – play October 30, 2024 23:38 Inactive
@vercel vercel bot temporarily deployed to Preview – workflows October 30, 2024 23:40 Inactive
@vercel vercel bot temporarily deployed to Preview – www October 30, 2024 23:41 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard October 30, 2024 23:42 Inactive
@chronark chronark added this pull request to the merge queue Oct 30, 2024
Merged via the queue into unkeyed:main with commit c531755 Oct 30, 2024
@oss-gg
Copy link

oss-gg bot commented Oct 30, 2024

Awarding unrenamed: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/unrenamed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API scoped permissions tooltip overflows due to the left side menu

2 participants